Skip to content

Update documentation to include assay models - #256

Open
Bankso wants to merge 8 commits into
mainfrom
docs-update-v13.0.0
Open

Update documentation to include assay models#256
Bankso wants to merge 8 commits into
mainfrom
docs-update-v13.0.0

Conversation

@Bankso

@Bankso Bankso commented Aug 12, 2026

Copy link
Copy Markdown
Contributor

Changelog

  • updated documentation to align with updated model and to surface experimental metadata model details
  • updated docs language and organization
  • added additional columns to model references, including Pattern and a direct link to controlled vocab, if applicable

Review needed for markdown files added to docs/models (biospecimen.md, etc.):

  • read through content and assess relevance, clarity
  • update to remove references/language that are not helpful/relevant
  • test model page navigation and controlled vocab links (once deployed)

Next steps (ongoing in separate branch, https://github.com/mc2-center/data-models/tree/docs-with-mapping-updates):

  • add descriptions and ontology IRIs for commonly used valid values

Bankso and others added 7 commits July 31, 2026 14:56
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Removed a duplicate Biospecimen Key entry from visiumRNALevel2's manifest
and re-ran the valid-values sync so Study/shared data-use-code fields
match the current DUO ontology IDs in duo.csv instead of stale short codes.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
…ence

Adds docs pages, download templates, and Standard Terms wiring for 24 models across modules: Biospecimen, Individual, Model, Imaging, NanoString GeoMx, Sequencing, 10x Visium. Reworks generate_linked_table() so each model's Full Field Reference is built from its live DependsOn list cross-checked against its JSON Schema export, sourced from the fully-collated mc2.model.csv rather than each module's own fragmentary CSV - this fixes missing/stale columns (e.g. Biospecimen was missing its foreign-key columns, Study still listed access-requirement fields already moved to governance). Reorganizes the Data Models nav into Sample, Administrative, Resource Sharing, and assay-specific subgroups.

Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
@Bankso
Bankso requested a review from a team as a code owner August 12, 2026 23:39
@Bankso Bankso added the documentation Improvements or additions to documentation label Aug 12, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant